[META 319] Align sanitize_field_names with cross-agent spec #982
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
💚 Flaky test reportTests succeeded. Expand to view the summary
Test stats 🧪
|
The value of the credit card check was dubious, and this change will improve performance.
beniwohli
approved these changes
Jan 7, 2021
beniwohli
pushed a commit
to beniwohli/apm-agent-python
that referenced
this pull request
Sep 14, 2021
) * Align sanitize_field_names with cross-agent spec * Add CHANGELOG * Remove value sanitization The value of the credit card check was dubious, and this change will improve performance. * Move to MASK recommended by elastic/apm#378 * Update changelog * Remove querystring sanitization * Update pre-commit to match upstream black behavior * Dynamically generate BASE_SANITIZE_FIELD_NAMES * Fix the merge commit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this pull request do?
Aligns the python agent's behavior and default for the
sanitize_field_namesconfig with that defined in the cross-agent specNote that this is a breaking change. Previously, entries in
sanitize_field_nameswould be checked with anif pattern in keycheck. This meant that"secret"would match (and mask)"the_secret". With the change to wildcard glob matching, this will no longer be the case. Users should add stars to each side of their matches (i.e."*secret*") in order to retain the previous behavior.The value sanitization of credit card numbers has also been removed. The credit card validation was of dubious value and removing it will improve performance.
Additionally, the sanitization of request querystrings has been removed.
Finally, the sanitization mask has been changed to
"[REDACTED]", to match the recommendation from elastic/apm#378.This PR should be merged for version 6.0, which will coincide with the 7.11 stack release.
Related issues
Closes #904
Closes #920